Configuration properties changelog generator misses items that are removed without prior deprecation #45267
+41
−11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spring-projects-issues
added
the
status: waiting-for-triage
The changelog generator did not detect properties that were added to a new version with error-level deprecation (indicating immediate removal). This commonly occurs when upgrading dependencies like Flyway 10, where properties are removed without prior deprecation. Modified the computeDifferences method to detect properties that only exist in the new metadata with error-level deprecation and properly mark them as DELETED in the changelog. Signed-off-by: yybmion <yunyubin54@gmail.com>
wilkinsona
changed the title
wilkinsona
reviewed
Apr 25, 2025
Comment on lines
+53
to
+60
| if (newProperty == null) { | ||
| differences.add(new Difference(DifferenceType.DELETED, oldProperty, null)); | ||
| } | ||
| else { | ||
| Difference difference = Difference.compute(oldProperty, newProperty); | ||
| if (difference != null) { | ||
| differences.add(difference); | ||
| } |
There was a problem hiding this comment.
This change isn't necessary as Difference.compute already handles the case where newProperty is null. Additionally, it checks that the old property isn't deprecated at error level before reporting a difference, something that's lost here.
I'll revert this part of the changes and add a test for this scenario (removing metadata for a property that's deprecated at error level) as part of merging this.
There was a problem hiding this comment.
I appreciate your explanation about why that part of the change wasn't necessary and how the existing code already handles the case.
wilkinsona
added
type: task
wilkinsona
pushed a commit
that referenced
this pull request
Apr 25, 2025
The changelog generator did not detect properties that were added to a new version with error-level deprecation (indicating immediate removal). This commonly occurs when upgrading dependencies like Flyway 10, where properties are removed without prior deprecation. Modified the computeDifferences method to detect properties that only exist in the new metadata with error-level deprecation and properly mark them as DELETED in the changelog. See gh-45267 Signed-off-by: yybmion <yunyubin54@gmail.com>
wilkinsona
added a commit
that referenced
this pull request
Apr 25, 2025
|
Thanks very much, @yybmion, and congratulations on making your first contribution to Spring Boot. |
|
Thank you @wilkinsona for reviewing and merging the PR! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
Closes #40075
The configuration properties changelog generator misses items that are removed without prior deprecation. When a property is removed without being deprecated first (like during the Flyway 10 upgrade), these changes are reflected in the metadata but not included in the generated changelog.
Solution
Modified the
computeDifferencesmethod in theChangelogclass to detect properties that only exist in the new metadata with error-level deprecation and properly mark them as DELETED in the changelog. This ensures that properties that are added to a new version with error-level deprecation (indicating immediate removal) are correctly included in the "Removed in X.X" section of the changelog.Specifically, added logic to check for properties in the new metadata that
Tests
The existing test
diffContainsDifferencesBetweenLeftAndRightInputsalready verifies this functionality by testing that properties with error-level deprecation are properly classified as DELETED.To make the test cover this fix, we enhanced the
sample-2.0.jsontest data to include an additional property (test.removed.directly) that demonstrates a property removed without prior deprecation, marked with error-level deprecation and a reason "Removed in Upgrade 10".After fix, this test confirms that both regular removed properties and those marked with error-level deprecation are correctly included in the changelog.